API Documentation
Public Types | Public Member Functions | List of all members
nkWinUi::Static Class Reference

A graphical static text zone. More...

Inheritance diagram for nkWinUi::Static:
nkWinUi::Component nkExport::Exportable

Public Types

enum  ALIGNMENT { ALIGNMENT::LEFT = 0, ALIGNMENT::CENTER, ALIGNMENT::RIGHT }
 Possible alignment values for the text. More...
 

Public Member Functions

 Static ()
 
 ~Static ()
 
ALIGNMENT getAlign () const
 
virtual void setAlign (ALIGNMENT value)
 
const char * alignToString (ALIGNMENT toConvert)
 
ALIGNMENT stringToAlign (const std::string_view &toConvert)
 
virtual void exportIntrospection (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkWinUi::Component
 Component ()
 
virtual ~Component ()
 
LayoutgetLayout () const
 
nkMaths::Point getPositionInParent () const
 
nkMaths::Point getPositionInScreen () const
 
int getWidth () const
 
int getHeight () const
 
nkMaths::Rectangle getArea () const
 
virtual nkMaths::Point getBorderExtents () const
 
virtual int getLayoutAllowedWidth () const
 
virtual int getLayoutAllowedHeight () const
 
virtual int getLayoutAllowedOffsetX () const
 
virtual int getLayoutAllowedOffsetY () const
 
bool isInitialized () const
 
ComponentgetParentComponent () const
 
COMPONENT_TYPE getComponentType () const
 
const char * getComponentName () const
 
bool getVisibility () const
 
virtual const char * getLabel () const
 
void * getData () const
 
bool isEnabled () const
 
bool isForegroundWindow () const
 
unsigned int getZDepth () const
 
bool getVisibleOnLoad () const
 
virtual LayoutsetLayout (LAYOUT_TYPE layoutType)
 
virtual void setPositionInParent (nkMaths::Point position)
 
virtual void setPositionInScreen (nkMaths::Point position)
 
virtual void setSize (int width, int height)
 
virtual void setWidth (int width)
 
virtual void setHeight (int height)
 
void setMinSize (unsigned int width, unsigned int height)
 
void setMaxSize (unsigned int width, unsigned int height)
 
void setRatio (float widthOverHeight)
 
virtual void setArea (nkMaths::Rectangle area)
 
virtual void setParentComponent (Component *parent, bool makeItVisible=true)
 
virtual void setLabel (const std::string_view &label)
 
void setComponentName (const std::string_view &name)
 
virtual void setVisibility (bool value)
 
void setData (void *data)
 
void setEnabled (bool value)
 
void setVisibleOnLoad (bool value)
 
void addChild (Component *child, bool makeItVisible=true)
 
void removeChild (Component *child)
 
void removeChild (unsigned int index)
 
ComponentgetChild (unsigned int index)
 
unsigned int getChildIndex (Component *child)
 
void unloadWithChildren ()
 
void loadWithChildren ()
 
void updateZDepth ()
 
void bringToForeground ()
 
void focusWindow ()
 
nkMaths::Point getCoordRelativeFromAbsolute (const nkMaths::Point &absCoords)
 
nkMaths::Point getCoordAbsoluteFromRelative (const nkMaths::Point &relCoords)
 
virtual void load ()=0
 
virtual void unload ()=0
 
virtual void updateWindow ()
 
nkImages::Image paintToImage ()
 
void simulateEvent (const InputDescriptor &inputDescription)
 
void onSized ()
 
ContextMenucreateContextMenu ()
 
ContextMenugetCurrentContextMenu ()
 
void shutContextMenu ()
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

A graphical static text zone.

Member Enumeration Documentation

◆ ALIGNMENT

Possible alignment values for the text.

Enumerator
LEFT 

Left of the static zone.

CENTER 

Center of the static zone.

RIGHT 

Right of the static zone.

Constructor & Destructor Documentation

◆ Static()

nkWinUi::Static::Static ( )

Constructor.

◆ ~Static()

nkWinUi::Static::~Static ( )

Destructor.

Member Function Documentation

◆ getAlign()

ALIGNMENT nkWinUi::Static::getAlign ( ) const
Returns
Current alignment used for text.

◆ setAlign()

virtual void nkWinUi::Static::setAlign ( ALIGNMENT  value)
virtual

Sets the alignment used for text inside the static.

Parameters
valueThe alignment to use.

◆ alignToString()

const char* nkWinUi::Static::alignToString ( ALIGNMENT  toConvert)

Converts an alignment value to a string.

Parameters
toConvertThe aligmnent enum value to convert.
Returns
The string associated to the enum value.

◆ stringToAlign()

ALIGNMENT nkWinUi::Static::stringToAlign ( const std::string_view &  toConvert)

Converts a string to the associated alignment, if any.

Parameters
toConvertThe string to convert into a enum value.
Returns
If the string corresponds to a good enum value, the associated enum value.

◆ exportIntrospection()

virtual void nkWinUi::Static::exportIntrospection ( nkExport::Node rootNode)
overridevirtual

◆ importClassFromTree()

virtual void nkWinUi::Static::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

The documentation for this class was generated from the following file: